examples: add .preflight/ starter config with annotated examples#310
Open
TerminalGravity wants to merge 2 commits intomainfrom
Open
examples: add .preflight/ starter config with annotated examples#310TerminalGravity wants to merge 2 commits intomainfrom
TerminalGravity wants to merge 2 commits intomainfrom
Conversation
The interactive setup wizard (npx preflight-dev init) was buried in a footnote under Option C, despite being the most user-friendly onboarding path. Moved it to Option A with a clear description of what it does. Renumbered remaining options accordingly.
The README and examples/README.md both referenced examples/.preflight/ but the directory didn't exist. Adds: - config.yml — profile, related projects, thresholds, embeddings - triage.yml — keyword rules, strictness, cross-service triggers - contracts/api.yml — manual contract definitions with realistic examples All files have detailed comments explaining every option.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README and examples/README.md both reference
examples/.preflight/but the directory didn't exist — broken link for anyone following the docs.Adds three annotated example files:
All files have detailed inline comments explaining every option so users can copy-paste and customize without reading the full docs.